/*
 * Copyright (c) 2010, okazoh_tk. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *  - Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *  - Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *  - Neither the name of the copyright holder nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef ALKES_STREAM_H_INCLUDED_
#define ALKES_STREAM_H_INCLUDED_

#include "alkes/internal.h"
#include "alkes/core/TBitArray.h"

namespace alkes {

/// \addtogroup io
//@{

enum SeekOrigin
{
    AL_ORIGIN_BEGIN = 0,
    AL_ORIGIN_CURRENT,
    AL_ORIGIN_END,
};

class AL_EXPORT Stream
{
public:

    bool canSeek() const;
    bool canRead() const;
    bool canWrite() const;

    int64_t getLength();
    int64_t getPosition();

    int32_t read(int32_t count, void* buffer, int32_t offset = 0);
    int32_t write(int32_t count, const void* buffer, int32_t offset = 0);
    int64_t seek(int64_t offset, SeekOrigin origin);

    void flush();
    void close();

protected:

    enum Attribute
    {
        READABLE = 0x0001,
        WRITABLE = 0x0002,
        SEEKABLE = 0x0004,
        READWRITE = READABLE|WRITABLE,
    };

    typedef uint32_t Attributes;

    Stream(Attributes attributes = READWRITE|SEEKABLE);
    virtual ~Stream() = 0;

    void changeAttributes(Attributes attributes);

    virtual int64_t onGetLength();
    virtual int64_t onGetPosition();

    virtual int32_t onRead(int32_t count, void* buffer, int32_t offset);
    virtual int32_t onWrite(int32_t count, const void* buffer, int32_t offset);
    virtual int64_t onSeek(int64_t offset, SeekOrigin origin);

    virtual void onFlush();
    virtual void onClose();

private:
    Attributes attributes_;
};

//@}

}

#endif
